home *** CD-ROM | disk | FTP | other *** search
/ Apple WWDC 1996 / WWDC96_1996 (CD).toast / Technology Materials / QuickTime VR / Windows / Interfaces / QD3DErrors.h < prev    next >
Encoding:
C/C++ Source or Header  |  1996-05-03  |  8.9 KB  |  320 lines  |  [TEXT/MPS ]
  1. /******************************************************************************
  2.  **                                                                             **
  3.  **     Module:        QD3DErrors.h                                             **
  4.  **                                                                             **
  5.  **                                                                             **
  6.  **     Purpose:    Error API and error codes                                 **
  7.  **                                                                             **
  8.  **                                                                             **
  9.  **     Copyright (C) 1992-1995 Apple Computer, Inc.  All rights reserved.     **
  10.  **                                                                             **
  11.  *****************************************************************************/
  12. #ifndef QD3DError_h
  13. #define QD3DError_h
  14.  
  15. #if PRAGMA_ONCE
  16.     #pragma once
  17. #endif
  18.  
  19. #if defined(OS_MACINTOSH) && OS_MACINTOSH
  20. #include <Types.h>
  21. #endif  /*  OS_MACINTOSH  */
  22.  
  23. #if defined(THINK_C) || defined(__SC__)
  24.     #pragma options(!pack_enums, !align_arrays)
  25.     #pragma SC options align=power
  26. #elif defined(__MWERKS__)
  27.     #pragma enumsalwaysint on
  28.     #pragma align_array_members off
  29.     #pragma options align=native
  30. #elif defined(__PPCC__)
  31.     #pragma options align=power
  32. #elif defined(__xlc) || defined(__xlC) || defined(__xlC__) || defined(__XLC121__)
  33.     #pragma options enum=int
  34. #endif
  35.  
  36. #ifdef __cplusplus
  37. extern "C" {
  38. #endif  /*  __cplusplus  */
  39.  
  40.  
  41. /******************************************************************************
  42.  **                                                                             **
  43.  **                            Error Types and Codes                             **
  44.  **                                                                             **
  45.  *****************************************************************************/
  46.  
  47. typedef enum TQ3Error {
  48.     kQ3ErrorNone = 0,        
  49.     /* Fatal Errors */
  50.     kQ3ErrorInternalError            = -28500,
  51.     kQ3ErrorNoRecovery,
  52.     kQ3ErrorLastFatalError,
  53.     /* System Errors */
  54.     kQ3ErrorNotInitialized    = -28490,
  55.     kQ3ErrorAlreadyInitialized,
  56.     kQ3ErrorUnimplemented,
  57.     kQ3ErrorRegistrationFailed,
  58.     /* OS Errors */
  59.     kQ3ErrorUnixError,
  60.     kQ3ErrorMacintoshError,
  61.     kQ3ErrorX11Error,
  62.     /* Memory Errors */
  63.     kQ3ErrorMemoryLeak,
  64.     kQ3ErrorOutOfMemory,
  65.     /* Parameter errors */
  66.     kQ3ErrorNULLParameter,
  67.     kQ3ErrorParameterOutOfRange,
  68.     kQ3ErrorInvalidParameter,            
  69.     kQ3ErrorInvalidData,                
  70.     kQ3ErrorAcceleratorAlreadySet,        
  71.     kQ3ErrorVector3DNotUnitLength,
  72.     kQ3ErrorVector3DZeroLength,
  73.     /* Object Errors */
  74.     kQ3ErrorInvalidObject,
  75.     kQ3ErrorInvalidObjectClass,
  76.     kQ3ErrorInvalidObjectType,
  77.     kQ3ErrorInvalidObjectName,
  78.     kQ3ErrorObjectClassInUse,            
  79.     kQ3ErrorAccessRestricted,
  80.     kQ3ErrorMetaHandlerRequired,
  81.     kQ3ErrorNeedRequiredMethods,
  82.     kQ3ErrorNoSubClassType,
  83.     kQ3ErrorUnknownElementType,
  84.     kQ3ErrorNotSupported,
  85.     /* Extension Errors */
  86.     kQ3ErrorNoExtensionsFolder,
  87.     kQ3ErrorExtensionError,
  88.     kQ3ErrorPrivateExtensionError,
  89.     /* Geometry Errors */
  90.     kQ3ErrorDegenerateGeometry,
  91.     kQ3ErrorGeometryInsufficientNumberOfPoints,
  92.     /* IO Errors */
  93.     kQ3ErrorNoStorageSetForFile,
  94.     kQ3ErrorEndOfFile,
  95.     kQ3ErrorFileCancelled,
  96.     kQ3ErrorInvalidMetafile,
  97.      kQ3ErrorInvalidMetafilePrimitive,
  98.      kQ3ErrorInvalidMetafileLabel,
  99.      kQ3ErrorInvalidMetafileObject,
  100.      kQ3ErrorInvalidMetafileSubObject,
  101.     kQ3ErrorInvalidSubObjectForObject,
  102.     kQ3ErrorUnresolvableReference,
  103.     kQ3ErrorUnknownObject,
  104.     kQ3ErrorStorageInUse,
  105.     kQ3ErrorStorageAlreadyOpen,
  106.     kQ3ErrorStorageNotOpen,
  107.     kQ3ErrorStorageIsOpen,
  108.     kQ3ErrorFileAlreadyOpen,
  109.     kQ3ErrorFileNotOpen,
  110.     kQ3ErrorFileIsOpen,
  111.     kQ3ErrorBeginWriteAlreadyCalled,
  112.     kQ3ErrorBeginWriteNotCalled,
  113.     kQ3ErrorEndWriteNotCalled,
  114.     kQ3ErrorReadStateInactive,
  115.     kQ3ErrorStateUnavailable,
  116.     kQ3ErrorWriteStateInactive,
  117.     kQ3ErrorSizeNotLongAligned,
  118.     kQ3ErrorFileModeRestriction,
  119.     kQ3ErrorInvalidHexString,
  120.     kQ3ErrorWroteMoreThanSize,
  121.     kQ3ErrorWroteLessThanSize,
  122.     kQ3ErrorReadLessThanSize,
  123.     kQ3ErrorReadMoreThanSize,
  124.     kQ3ErrorNoBeginGroup,
  125.     kQ3ErrorSizeMismatch,
  126.     kQ3ErrorStringExceedsMaximumLength,
  127.     kQ3ErrorValueExceedsMaximumSize,
  128.     kQ3ErrorNonUniqueLabel,
  129.     kQ3ErrorEndOfContainer,
  130.     kQ3ErrorUnmatchedEndGroup,
  131.     kQ3ErrorFileVersionExists,
  132.     /* View errors */
  133.     kQ3ErrorViewNotStarted,
  134.     kQ3ErrorViewIsStarted,
  135.     kQ3ErrorRendererNotSet,
  136.     kQ3ErrorRenderingIsActive,
  137.     kQ3ErrorImmediateModeUnderflow,
  138.     kQ3ErrorDisplayNotSet,
  139.     kQ3ErrorCameraNotSet,
  140.     kQ3ErrorDrawContextNotSet,
  141.     kQ3ErrorNonInvertibleMatrix,
  142.     kQ3ErrorRenderingNotStarted,
  143.     kQ3ErrorPickingNotStarted,
  144.     kQ3ErrorBoundsNotStarted,
  145.     kQ3ErrorDataNotAvailable,
  146.     kQ3ErrorNothingToPop,
  147.     /* Renderer Errors */
  148.     kQ3ErrorUnknownStudioType,            
  149.     kQ3ErrorAlreadyRendering,
  150.     kQ3ErrorStartGroupRange,
  151.     kQ3ErrorUnsupportedGeometryType,
  152.     kQ3ErrorInvalidGeometryType,
  153.     kQ3ErrorUnsupportedFunctionality,
  154.     /* Group Errors */
  155.     kQ3ErrorInvalidPositionForGroup,
  156.     kQ3ErrorInvalidObjectForGroup,
  157.     kQ3ErrorInvalidObjectForPosition,
  158.     /* Transform Errors */
  159.     kQ3ErrorScaleOfZero,                
  160.     /* String Errors */
  161.     kQ3ErrorBadStringType,                
  162.     /* Attribute Errors */
  163.     kQ3ErrorAttributeNotContained,        
  164.     kQ3ErrorAttributeInvalidType,        
  165.     /* Camera Errors */
  166.     kQ3ErrorInvalidCameraValues,        
  167.     /* DrawContext Errors */
  168.     kQ3ErrorBadDrawContextType,
  169.     kQ3ErrorBadDrawContextFlag,
  170.     kQ3ErrorBadDrawContext,
  171.     kQ3ErrorUnsupportedPixelDepth,
  172.     /* Controller Errors */
  173.     kQ3ErrorController,
  174.     /* Tracker Errors */
  175.     kQ3ErrorTracker,
  176.     /* Another OS Error */
  177.     kQ3ErrorWin32Error
  178. } TQ3Error;
  179.  
  180. typedef enum TQ3Warning {
  181.     kQ3WarningNone = 0,
  182.     /* General System */
  183.     kQ3WarningInternalException = -28300,    
  184.     /* Object Warnings */
  185.     kQ3WarningNoObjectSupportForDuplicateMethod,
  186.     kQ3WarningNoObjectSupportForDrawMethod,
  187.     kQ3WarningNoObjectSupportForWriteMethod,
  188.     kQ3WarningNoObjectSupportForReadMethod,
  189.     kQ3WarningUnknownElementType,
  190.     kQ3WarningTypeAndMethodAlreadyDefined,
  191.     kQ3WarningTypeIsOutOfRange,
  192.     kQ3WarningTypeHasNotBeenRegistered,
  193.     /* Parameter Warnings */
  194.     kQ3WarningVector3DNotUnitLength,
  195.     /* IO Warnings */
  196.     kQ3WarningInvalidSubObjectForObject,
  197.     kQ3WarningInvalidHexString,
  198.     kQ3WarningUnknownObject,
  199.     kQ3WarningInvalidMetafileObject,
  200.     kQ3WarningUnmatchedBeginGroup,
  201.     kQ3WarningUnmatchedEndGroup,
  202.     kQ3WarningInvalidTableOfContents,
  203.     kQ3WarningUnresolvableReference,
  204.     kQ3WarningNoAttachMethod,
  205.     kQ3WarningInconsistentData,
  206.     kQ3WarningReadLessThanSize,
  207.     kQ3WarningFilePointerResolutionFailed,
  208.     kQ3WarningFilePointerRedefined,
  209.     kQ3WarningStringExceedsMaximumLength,
  210.     /* Memory Warnings */
  211.     kQ3WarningLowMemory,
  212.     kQ3WarningPossibleMemoryLeak,
  213.     /* View Warnings */
  214.     kQ3WarningViewTraversalInProgress,
  215.     kQ3WarningNonInvertibleMatrix,
  216.     /* Quaternion Warning */
  217.     kQ3WarningQuaternionEntriesAreZero,
  218.     /* Renderer Warning */
  219.     kQ3WarningFunctionalityNotSupported,
  220.     /* DrawContext Warning */
  221.     kQ3WarningInvalidPaneDimensions,
  222.     /* Pick Warning */
  223.     kQ3WarningPickParamOutside,
  224.     /* Scale Warnings */
  225.     kQ3WarningScaleEntriesAllZero,
  226.     kQ3WarningScaleContainsNegativeEntries,
  227.     /* Generic Warnings */
  228.     kQ3WarningParameterOutOfRange
  229. } TQ3Warning;
  230.  
  231.  
  232. typedef enum TQ3Notice {
  233.     kQ3NoticeNone = 0,
  234.     kQ3NoticeDataAlreadyEmpty = -28100,
  235.     kQ3NoticeMethodNotSupported,
  236.     kQ3NoticeObjectAlreadySet,
  237.     kQ3NoticeParameterOutOfRange,
  238.     kQ3NoticeFileAliasWasChanged,
  239.     kQ3NoticeMeshVertexHasNoComponent,
  240.     kQ3NoticeMeshInvalidVertexFacePair,
  241.     kQ3NoticeMeshEdgeVertexDoNotCorrespond,
  242.     kQ3NoticeMeshEdgeIsNotBoundary,
  243.     kQ3NoticeDrawContextNotSetUsingInternalDefaults,
  244.     kQ3NoticeInvalidAttenuationTypeUsingInternalDefaults,
  245.     kQ3NoticeBrightnessGreaterThanOne,
  246.     kQ3NoticeScaleContainsZeroEntries,
  247.     kQ3NoticeSystemAlreadyInitialized,
  248.     kQ3NoticeViewSyncCalledAgain
  249. } TQ3Notice;
  250.  
  251. typedef void (*TQ3ErrorMethod)(
  252.     TQ3Error    firstError,
  253.     TQ3Error    lastError,
  254.     long        reference);
  255.     
  256. typedef void (*TQ3WarningMethod)(
  257.     TQ3Warning    firstWarning,
  258.     TQ3Warning    lastWarning,
  259.     long        reference);
  260.  
  261. typedef void (*TQ3NoticeMethod)(
  262.     TQ3Notice    firstNotice,
  263.     TQ3Notice    lastNotice,
  264.     long        reference);
  265.  
  266.  
  267. /******************************************************************************
  268.  **                                                                             **
  269.  **                                Error Routines                                 **
  270.  **                                                                             **
  271.  *****************************************************************************/
  272.  
  273. QD3D_EXPORT TQ3Status Q3Error_Register(
  274.     TQ3ErrorMethod        errorPost,
  275.     long                reference);
  276.  
  277. QD3D_EXPORT TQ3Status Q3Warning_Register(
  278.     TQ3WarningMethod    warningPost,
  279.     long                reference);
  280.  
  281. QD3D_EXPORT TQ3Status Q3Notice_Register(
  282.     TQ3NoticeMethod        noticePost,
  283.     long                reference);
  284.  
  285. /*
  286.  *  Getting error codes -
  287.  *    Clears error type on next entry into system (except all of these 
  288.  *  error calls), and returns the last error, and optionally the 
  289.  *    first error. The parameter to these "_Get" calls may be NULL.
  290.  */
  291. QD3D_EXPORT TQ3Error Q3Error_Get(
  292.     TQ3Error            *firstError);
  293.  
  294. QD3D_EXPORT TQ3Boolean Q3Error_IsFatalError(
  295.     TQ3Error            error);
  296.  
  297. QD3D_EXPORT TQ3Warning Q3Warning_Get(
  298.     TQ3Warning            *firstWarning);
  299.  
  300. QD3D_EXPORT TQ3Notice Q3Notice_Get(
  301.     TQ3Notice            *firstNotice);
  302.  
  303. #if defined(OS_MACINTOSH) && OS_MACINTOSH
  304.  
  305. QD3D_EXPORT OSErr Q3MacintoshError_Get(
  306.     OSErr                *firstMacErr);
  307.  
  308. #endif  /*  OS_MACINTOSH  */
  309. #ifdef __cplusplus
  310. }
  311. #endif  /*  __cplusplus  */
  312.  
  313. #if defined(__MWERKS__)
  314.     #pragma enumsalwaysint reset
  315. #elif defined(__xlc) || defined(__xlC) || defined(__xlC__) || defined(__XLC121__)
  316.     #pragma options enum=reset
  317. #endif
  318.  
  319. #endif    /*  QD3DError_h  */
  320.